<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\objects;

abstract class PropertyEditor
{
	/**
	 * Determines whether this editor can edit the specified value.
	 * 
	 * @param  mixed $propertyValue
	 *         A candidate for editing.
	 * @return bool
	 *         TRUE if this editor can edit the specified value;
	 *         FALSE otherwise.
	 */
	public function canEditProperty($propertyValue)
	{
		return true;
	}
	
	/**
	 * Edits the given property so that it meets this editor's format.
	 * 
	 * @param  mixed $propertyValue
	 *         A value to be edited.
	 * @return mixed
	 *         An edited value.
	 * @throws BadMethodCallException
	 *         If this editor can not handle the given property value.
	 */
	abstract public function editProperty($propertyValue);
}